home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / os2 / cinet117.zip / INSTALL.DAT / cinet.doc < prev    next >
Text File  |  1997-05-29  |  10KB  |  283 lines
  1. CitrusSoft BBS Internet Kit (c) copyright 1997 Tom Fotherby, all rights reserved
  2. --------------------------------------------------------------------------------
  3.  
  4. Disclaimer
  5. ----------
  6.  All of the files in this package become the sole responsibility of the
  7.  user.  The author of this product can not,  and will not be liable for
  8.  any use, misuse, and/or damages caused by this product.
  9.  
  10. Features
  11. --------
  12.  · 32-bit OS/2 Native programs
  13.  · Uses very little system resources
  14.  · Runs with both DOS & OS/2 BBS Software
  15.  · Easy to set up
  16.  · Fully Multi-Node Compatible
  17.  · FTP, IRC and Telnet doors
  18.  · The users love them!!
  19.  
  20. Requirements
  21. ------------
  22.  · An IBM/PC Computer (386 or better) running OS/2 v3 (or newer)
  23.    with IAK or TCP/IP v2.0+
  24.  · A Connection to the internet [Slip / PPP / Lan]
  25.    *note* A 28.8k Slip/PPP line will work great! :)
  26.  · Static IP is NOT required!
  27.  · A BBS! (They can also be run in Local mode, without a BBS)
  28.  
  29. Setting up
  30. ----------
  31. A) Run the installation program (INSTALL.EXE) - it will de-archive
  32.    the doors into the specified directory, and create the necessary
  33.    configuration files.
  34.  
  35. B) You will need an OS/2 X/Y/Zmodem protocol for the FTP door to work
  36.    Properly - it is suggested that you use CE-XYZ/2 v1.01. (XYZ2_101.ZIP)
  37.    *note* The FTP Door comes pre-configured to work with CE-XYZ/2.
  38.    All you have to do is unzip XYZ2_101.ZIP.
  39.  
  40. C) Set up your BBS to run the doors.
  41.  
  42. Command Line parameters (optional) :
  43.      /L         - Run the door locally
  44.      /D<path>   - Specify the path to the drop file (ex. /Dc:\bbs\)
  45.      /N<node>   - Specify which node this door is being run from (ex. /N1)
  46.                   [This is required for Multi-Node usage!]
  47.      /H<handle> - Have the door use an open (hot) ComPort Handle
  48.      /I<idle>   - The amount of time the user can be Inactive in the door
  49.                   Before the door quits back to the BBS
  50.      /T<time>   -*Specify how much time the user can have in the door
  51.      /S<server> - Specify the IRC server to connect to
  52.                   [Use "/Sask" to prompt the user for an irc server name]
  53.      /P<port>   - Specify the Port at which to connect to
  54.      /U         - Use "Alias" on line #36 of door.sys (if available)
  55.      /A<ip>     - Specify your IP address (if having problems w/DCC or FTP)
  56.      /K         - Keep the DCC'd files when the door exits
  57.      /O         - Disable logging in the FTP/Telnet doors
  58.  
  59. ( * = registered version only )
  60.  
  61. The /A parameter would be useful for systems that are running via
  62. Masquerading IP.
  63.  
  64. [ setting up with an OS/2 native BBS software ]
  65.  
  66. Setting the doors up with an OS/2 BBS software is rather simple!
  67. Take, for example, Synchronet BBS Software for OS/2.
  68.  
  69. A) Add an "Online Program".
  70. B) Have it create a DOOR.SYS drop file in the NODE directory.
  71. C) For the "Startup Directory", put the same directory as you installed
  72.    the doors into via INSTALL.EXE
  73. D) For the "Command Line", put: telnet /n%# /dc:\sbbs\node%#
  74.    (in Synchronet BBS, %# is the macro for the node number)
  75. E) Add "TELNET" to the "OS/2 Programs List"
  76. F) Repeat the above steps for the IRC and FTP doors.
  77.  
  78. [ setting up with a DOS BBS software ]
  79.  
  80. If you are using a DOS BBS software, you will need to use the freeware
  81. program "HSTART".  (included in this package - hstart05.zip).
  82.  
  83. The following configuration assumes that you've unzipped the CitrusSoft
  84. BBS Internet Kit into "C:\CINET"!
  85.  
  86. Create the following files:
  87.  
  88. CINET.BAT, containing:
  89.  
  90. ----
  91. @echo off
  92. hstart.exe "%1 door" /fs /wait c:\cinet\cinet.cmd %1 %2 %3 %4 %5
  93. ----
  94.  
  95. CINET.CMD, containing:
  96.  
  97. ----
  98. c:
  99. cd\cinet
  100. %1.exe %2 %3 %4 %5
  101. hwait.exe
  102. exit
  103. ----
  104.  
  105. Now, instruct your BBS program to load cinet.bat with the parameter of
  106. telnet, ftp, or irc (depending on which one you want it to load).
  107.  
  108. example:
  109. CINET.BAT telnet <additional parameters, such as /Dc:\bbs ..etc.>
  110.  
  111. For more information on HSTART, refer to hstart.txt.
  112.  
  113. Configuration Files
  114. -------------------
  115. You may edit the following files with your favorite text editor  when
  116. changing them.  Instructions for making modifications reside  in each
  117. file.
  118.  
  119. FTP/TELNET/IRC.CFG
  120. ~~~~~~~~~~~~~~~~~~
  121. These are the main configuration files for the doors.  They are used
  122. to specify the BBS Name, Sysop Name, Drop file type, and Idle minutes.
  123. There are also special options for each door.
  124.  
  125. Line #5 in FTP.CFG allows you to configure your hostname (for anon logins)
  126. Line #5 in TELNET.CFG allows you to toggle the local screen IO (on/off)
  127. Line #5 in IRC.CFG allows you to toggle DCC file transfers (on/off)
  128.  
  129. PROTOCOL.CFG
  130. ~~~~~~~~~~~~
  131. This file allows you to customize/add/change file transfer protocols
  132. in the FTP Door.
  133.  
  134. CHANNELS.TXT
  135. ~~~~~~~~~~~~
  136. This is the file that gets presented to the user when they use  /LIST
  137. in the IRC Door.  If this file doesn't exist, the IRC Door  will  get
  138. the list of channels from the IRC Server (on the larger servers, such
  139. as EFFNet or UnderNet, this may take a long time!)
  140.  
  141. SERVERS.TXT
  142. ~~~~~~~~~~~
  143. This is the list of "default" IRC Servers that the user can connect to.
  144.  
  145. LOCKOUT.TXT
  146. ~~~~~~~~~~~
  147. You can use this file to put keywords, or partial channel names of channels
  148. that you don't want the users accessing.  (this is useful to keep the users
  149. out of channels that provide porn, or whatever, via dcc)
  150.  
  151. *.SCR
  152. ~~~~~
  153. These are scripts for the Telnet door.  You can create and use these to
  154. automatically log into different servers and such..  Check out the included
  155. script, WWW.SCR, it will automatically log into the LYNX (www) program at
  156. "public.sunsite.unc.edu"!
  157.  
  158. A note about Servers
  159. --------------------
  160. A server (Also known as a Site or Host) is 2 or more words, separated by
  161. a period, and usually ends in .COM, .ORG, .EDU, .NET or .GOV.
  162. If a FTP server is preceded with a 'ftp://', it will automatically log the
  163. user in anonymously.  Also, if a directory is specified on the end, it will
  164. change to that directory once logged in.  (ex: ftp://ftp.cdrom.com/pub)
  165.  
  166. Sysop Keys
  167. ----------
  168. ALT C, Chat with the User
  169. ALT +, Give the User time
  170. ALT -, Take away time
  171.  
  172. Having problems?
  173. ----------------
  174. If OS/2 pops up a box saying that the COM Port is allready in use when a
  175. user enters the door, you'll need to add the ",-" parameter to SIO.
  176. (Refer to Appendix D. of SIOREF.TXT)
  177.  
  178. If the door says that it is unable to Initialise the COM Port, you may
  179. have to pass the COM Port handle from the BBS Software to the door.
  180. (Refer to your BBS Software's documentation for information on how to do this)
  181.  
  182. If the FTP Door returns errors such as "Connection timed out" or
  183. "Cannot build data connection" and the DCC function in the IRC Door has
  184. trouble sending files, you will need to specify "/A<your-ip-address>" on
  185. the command line.  Example: ftp /A206.84.198.150 (other parameters go here)
  186.  
  187. Contacting the Author
  188. ---------------------
  189. If you...
  190.  
  191. A) Need additional help setting up and configuring these doors
  192. B) You want to report a problem / bug
  193. C) You have suggestions
  194. D) Just want to talk
  195.  
  196. You can contact me either via E-Mail or my BBS.
  197.  
  198. E-Mail:  enigma@ees.eesc.com
  199.  
  200. BBS:     The O-Zone BBS
  201.          Telnet: ozbbs.ml.org (ip address: 206.84.198.150)
  202.          Dialup: (248) 651-6472
  203.          Logon as NEW
  204.  
  205. Mail:    Tom Fotherby
  206.          3535 Hadden
  207.          Rochester, MI 48306
  208.          USA
  209.  
  210. (for quickest response, use e-mail :)
  211.  
  212. Registration
  213. ------------
  214. You are givin a 30-day evaluation period  to  test  out the CitrusSoft
  215. Internet Kit.  After your 30-day trial period, you must decide whether
  216. or not you wish to continue using it.  If you find that these programs
  217. meet your needs, you are required to register.
  218.  
  219. Registration is a One-time  fee  of  $45  (U.S. Dollars).  All  future
  220. Upgrades will be made available to registered users at no charge.
  221.  
  222. Benefits of Registration:
  223.  · No 10-minute time limit
  224.  · All of the 'registered' features will be enabled
  225.  · The Delays will be removed.
  226.  
  227. Types of payment accepted: Check or Money Order.
  228.  
  229. ( Sorry, we do not accept Credit Cards )
  230.  
  231. Please make the Check or Money Order out to: Tom Fotherby, along with your
  232. name and BBS Name, to:
  233.  
  234. Tom Fotherby
  235. 3535 Hadden
  236. Rochester, MI 48306
  237. USA
  238.  
  239. Specify where you'd like to receive the registered versions of the doors.
  240. I can send them either via E-Mail, or File Attach on my BBS.
  241. If you would like to receive it via Snail-Mail on a 3.5" floppy disk,
  242. include an additional $2.00.
  243.  
  244. Whats New in Version 1.17?
  245. --------------------------
  246. A) Local Screen IO is about 10x faster! (New VIO Buffering techniques)
  247. B) IRC: Optimized the DCC Code
  248. C) IRC: If CHANNELS.TXT doesn't exist, /LIST will get the channel list from
  249.    the IRC server.
  250. D) IRC: Ability to disallow access to certain irc channels (see LOCKOUT.TXT)
  251. E) Telnet: Scripting capabilities in the Telnet door!  Refer to CINET.DOC
  252.    and WWW.SCR for more info.
  253. E) Added parameter /O.  This will disable creating the .LOG files in the
  254.    Telnet and FTP doors.
  255. F) Telnet: Fixed a bug which caused Z-Modem and other transfer protocols
  256.    to fail.
  257.  
  258. Whats New in Version 1.16?
  259. --------------------------
  260. A) The parameter /? (or -?) will bring up a list of Commandline Parameters
  261.    For each door.
  262. B) Fixed a bug where the FTP & IRC Doors wouldn't delete the temporary files.
  263. C) Added parameter /K.  Using this parameter will SAVE the files, instead
  264.    Of deleting them when the door exits.
  265. D) Added parameter /U.  This will tell the door to use the Alias on line
  266.    #36 of the DOOR.SYS file, if available.  (Useful for PCB & RA systems)
  267.  
  268. Whats New in Version 1.1
  269. ------------------------
  270. A) The doors now use 2 methods of finding the local IP address.  On some
  271.    systems gethostid() would return 255.255.255.255 for the local IP,
  272.    causing the FTP door to function improperly (Cannot Build data connection).
  273.    If it can't get the local IP by gethostid(), it will run "netstat.exe -a"
  274.    to get the correct local IP.
  275. B) BugFix: The IRC door's "/DCC LIST",  sometimes it wouldn't display
  276.    the correct SENT/RECEIVED bytes.
  277. C) The IRC & FTP doors now clean up after themselves by deleting all
  278.    temporary and received files.
  279. D) BugFix: Using ALT-C (chat) in the FTP Door would sometimes cause a
  280.    runtime error.
  281. E) The IRC Door will now be able to connect to servers that require pIdentD
  282.    to be installed.
  283.